home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / buttonclass.doc < prev    next >
Encoding:
Text File  |  1994-11-19  |  2.5 KB  |  77 lines
  1.  
  2.            $RCSfile: buttonclass.doc,v $
  3.         Description: Buttonclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.2 $
  10.               $Date: 1994/11/09 20:20:48 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. buttonclass/--background--
  16. buttonclass/Methods
  17. buttonclass/Attributes
  18.  
  19. buttonclass/--background--                          buttonclass/--background--
  20.  
  21.     NAME
  22.         Class:          buttonclass
  23.         Superclass:     baseclass
  24.         Include File:   <llibraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To provide a gadget simular to the gadtools.library button  kind.  The
  28.         gadget can either be a normal button or a toggle button.   Vectorclass
  29.         attributes can be passed at create time to add imagery to the gadget.
  30.  
  31.         The  gadget  will  send  the following attributes in it's notification
  32.         events:
  33.  
  34.         GA_ID           - Gadget object ID.
  35.         GA_UserData     - Gadget object userdata contents.
  36.         GA_Selected     - Gadget object selected state.
  37.  
  38.         Please  note  that  the  gadget  will  send  out  interim notification
  39.         messages every single timer tick while the gadget is selected.
  40.  
  41. buttonclass/Methods                                        buttonclass/Methods
  42.  
  43.     NEW METHODS
  44.         None.
  45.  
  46.     CHANGED METHODS
  47.         None.
  48.  
  49. buttonclass/Attributes                                  buttonclass/Attributes
  50.  
  51.     NOTE: The  VIT_VectorArray  and  VIT_BuiltIn  attributes are also settable
  52.           with OM_SET or OM_UPDATE.
  53.  
  54.     NAME
  55.         GA_Selected - ( BOOL )
  56.  
  57.     FUNCTION
  58.         This  attributes  has  an  extended  applicability.  It  has been made
  59.         get-able  to  make  it  easy to inquire about the selected state of an
  60.         object.
  61.  
  62.         Default is FALSE. Applicability is (ISGNU).
  63.  
  64.     NAME
  65.         BUTTON_Image, BUTTON_SelectedImage -- ( struct Image * )
  66.  
  67.     FUNCTION
  68.         To provide a button object width a standard Intuition or BOOPSI image.
  69.         The images will be centered  inside the object  it's hitbox.  You  can
  70.         supply a selected image which is  shown when  the gadget  is selected.
  71.         If no selected imagery is  specified  the normal  image is  also shown
  72.         when the gadget is selected.
  73.  
  74.         This attribute overides the creation of a VectorClass image.
  75.  
  76.         Defaults are NULL. Applicability is (I).
  77.